dxp-ux
List Pricing Plans by Account
GET /pricingPlan
This usecase is used to retrieve the pricing plan details by sending account number as input.
URL
http://[localhost]:[port]/dxp-ux/v1/{businessId}/pricingPlanURL PARAMS
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (PA) identifying the business unit. | Y |
Headers
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
Query PARAMS
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| identityValue | string | Account number of the customer | Y (CWC) |
| identityType | string | Name of the identityValue. Note: This should be sent as "AccountId" | Y (CWC) |
| includeNomServices | string | To inculde the nominated services. Note: This should always be sent as true | Y(CWC) |
| state | string | state of the plan. Possible Values : ALL, Active | N(CWC) |
Data Model - Response
| field name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| planId | string | Name of the Plan | Y(CWC) |
| planName | string | description of the plan | Y(CWC) |
| planStatus | date-time | status of the plan | Y(CWC) |
| startDate | date-time | Plan start date | Y(CWC) |
| endDate | date-time | Plan end date | Y(CWC) |
| planIsActive | string | plan is active or inactive | Y(CWC) |
| nominatedServices[] | string | Service associated with the plan | Y(CWC) |
| nominatedServices[].serviceId | string | ServiceId of the service associated with the plan | Y(CWC) |
| nominatedServices[].startDate | date-time | StartDate of the service associated with the plan | Y(CWC) |
| nominatedServices[].endDate | string | endDate of the service associated with the plan | Y(CWC) |
Key considerations
Please find the response in the following link - DXP-UX - GET PricingPlan
Key considerations for CWC-Liberate markets
- PricingPlan is implemented for JM,AG,AI,VG,KY,DM,GD,MS,KN,VC,TC.
- planId is Name of the Plan.
- planName is description of the plan.
- planStatus is status of the plan. (possible values. W - Working, A - Allocated, B - Barred, C - Closed, D - Default)
- startDate is Plan start date.
- endDate is Plan end date.
- planIsActive defines plan is active or inactive.
- 'includeNomServices' queryParam should always be sent and it's value should be true.
- If the 'state' queryParam is not sent, all pricingPlans would be returned. If the 'state' queryParam is sent, it's value should always be "Active" and only active pricingPlans would be returned.
Key considerations for CWC-Cerillion markets
- PricingPlan is implemented for JM, BB, TT, LC, VC, GD, AG.
- This is applicable, if discountGroup is available for that specific BU.
- planId and planName would have the same value, as cerillionAPI is only returning allowanceName/planName.
- planStatus value is not available directly from cerillionAPI, so this would be derived based on startDate,EndDate of the plan. (possible values are "W" for Working/Active and "C" for Closed/Inactive).
- planIsActive value is not available directly from cerillionAPI, so this would be derived based on startDate,EndDate of the plan. (possible values are "true" or "false").
- 'includeNomServices' queryParam should always be sent and it's value should be true.
- If the 'state' queryParam is not sent, all pricingPlans would be returned. If the 'state' queryParam is sent, it's value should always be "Active" and only active pricingPlans would be returned.